/*
 * Copyright 2010 Alessandro Bellucci
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.soupframework.gwt.designerpanel.client.interaction;

import org.soupframework.gwt.designerpanel.client.DesignerPanel;

import com.google.gwt.event.shared.EventHandler;

public interface DesignerPanelInteractionHandler<T> extends EventHandler {

	/**
	 * Register this handler with a {@link DesignerPanel}
	 *
	 * @param designerPanel The {@link DesignerPanel} to register this handler to
	 */
	public void registerToDesignerPanel(DesignerPanel<T> designerPanel);

	/**
	 * Gets the {@link InteractionMode} of this handler
	 * @return The interaction mode
	 */
	public InteractionMode getInteractionMode();

	/**
	 * Sets the {@link InteractionMode} of this handler
	 *
	 * @param interactionMode The interaction mode
	 */
	public void setInteractionMode(InteractionMode interactionMode);

	/**
	 * Gets the handler for the addition of new widgets to the associated {@link DesignerPanel}
	 * @return The {@link NewObjectsHandler}
	 */
	public NewObjectsHandler<T> getNewWidgetsHandler();

	/**
	 * Sets the handler for the addition of new widgets to the associated {@link DesignerPanel}
	 *
	 * @param newWidgetsHandler The {@link NewObjectsHandler}
	 */
	public void setNewWidgetsHandler(NewObjectsHandler<T> newWidgetsHandler);
}
